home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 November / macformat-018.iso / Utility Spectacular / Utilities / Calc / help / builtin next >
Encoding:
Text File  |  1992-02-24  |  12.4 KB  |  257 lines  |  [TEXT/????]

  1. Builtin functions
  2.  
  3.     There is a large number of built-in functions.  Many of the
  4.     functions work on several types of arguments, whereas some only
  5.     work for the correct types (e.g., numbers or strings).  In the
  6.     following description, this is indicated by whether or not the
  7.     description refers to values or numbers.  This display is generated
  8.     by the 'show builtins' command.
  9.  
  10.         Name    Args    Description
  11.  
  12.         abs       1-2    absolute value within accuracy b
  13.         acos      1-2    arccosine of a within accuracy b
  14.         acosh     1-2    hyperbolic arccosine of a within accuracy b
  15.         append    2      append value to end of list
  16.         appr      1-2    approximate a with simpler fraction to within b
  17.         arg       1-2    argument (the angle) of complex number
  18.         asin      1-2    arcsine of a within accuracy b
  19.         asinh     1-2    hyperbolic arcsine of a within accuracy b
  20.         atan      1-2    arctangent of a within accuracy b
  21.         atan2     2-3    angle to point (b,a) within accuracy c
  22.         atanh     1-2    hyperbolic arctangent of a within accuracy b
  23.         avg       1+     arithmetic mean of values
  24.         bround    1-2    round value a to b number of binary places
  25.         btrunc    1-2    truncate a to b number of binary places
  26.         ceil      1      smallest integer greater than or equal to number
  27.         cfappr    1-2    approximate a within accuracy b using
  28.                 continued fractions
  29.         cfsim     1      simplify number using continued fractions
  30.         char      1      character corresponding to integer value
  31.         cmp       2      compare values returning -1, 0, or 1
  32.         comb      2      combinatorial number a!/b!(a-b)!
  33.         config    1-2    set or read configuration value
  34.         conj      1      complex conjugate of value
  35.         cos       1-2    cosine of value a within accuracy b
  36.         cosh      1-2    hyperbolic cosine of a within accuracy b
  37.         cp        2      cross product of two vectors
  38.         delete    2      delete element from list a at position b
  39.         den       1      denominator of fraction
  40.         det       1      determinant of matrix
  41.         digit     2      digit at specified decimal place of number
  42.         digits    1      number of digits in number
  43.         dp        2      dot product of two vectors
  44.         epsilon   0-1    set or read allowed error for real calculations
  45.         eval      1      evaluate expression from string to value
  46.         exp       1-2    exponential of value a within accuracy b
  47.         fcnt      2      count of times one number divides another
  48.         fib       1      Fibonacci number F(n)
  49.         frem      2      number with all occurrence of factor removed
  50.         fact      1      factorial
  51.         fclose    1      close file
  52.         feof      1      whether EOF reached for file
  53.         ferror    1      whether error occurred for file
  54.         fflush    1      flush output to file
  55.         fgetc     1      read next char from file
  56.         fgetline  1      read next line from file
  57.         files     0-1    return opened file or max number of opened files
  58.         floor     1      greatest integer less than or equal to number
  59.         fopen     2      open file name a in mode b
  60.         fprintf   2+     print formatted output to opened file
  61.         frac      1      fractional part of value
  62.         gcd       1+     greatest common divisor
  63.         gcdrem    2      a divided repeatedly by gcd with b
  64.         highbit   1      high bit number in base 2 representation
  65.         hmean     1+     harmonic mean of values
  66.         hypot     2-3    hypotenuse of right triangle within accuracy c
  67.         ilog      2      integral log of one number with another
  68.         ilog10    1      integral log of a number base 10
  69.         ilog2     1      integral log of a number base 2
  70.         im        1      imaginary part of complex number
  71.         insert    3      insert value c into list a at position b
  72.         int       1      integer part of value
  73.         inverse   1      multiplicative inverse of value
  74.         iroot     2      integer b'th root of a
  75.         iseven    1      whether a value is an even integer
  76.         isfile    1      whether a value is a file
  77.         isint     1      whether a value is an integer
  78.         islist    1      whether a value is a list
  79.         ismat     1      whether a value is a matrix
  80.         ismult    2      whether a is a multiple of b
  81.         isnull    1      whether a value is the null value
  82.         isnum     1      whether a value is a number
  83.         isobj     1      whether a value is an object
  84.         isodd     1      whether a value is an odd integer
  85.         isqrt     1      integer part of square root
  86.         isreal    1      whether a value is a real number
  87.         isset     2      whether bit b of abs(a) (in base 2) is set
  88.         isstr     1      whether a value is a string
  89.         isrel     2      whether two numbers are relatively prime
  90.         issimple  1      whether value is a simple type
  91.         issq      1      whether or not number is a square
  92.         istype    2      whether the type of a is same as the type of b
  93.         jacobi    2      -1 => a is not quadratic residue mod b
  94.                  1 => b is composite, or a is quad residue of b
  95.         lcm       1+     least common multiple
  96.         lcmfact   1      lcm of all integers up till number
  97.         lfactor   2      lowest prime factor of a in first b primes
  98.         list      0+     create list of specified values
  99.         ln        1-2    natural logarithm of value a within accuracy b
  100.         lowbit    1      low bit number in base 2 representation
  101.         ltol      1-2    leg-to-leg of unit right triangle
  102.                      (sqrt(1 - a^2))
  103.         matdim    1      number of dimensions of matrix
  104.         matfill   2-3    fill matrix with value b (value c on diagonal)
  105.         matmax    2      maximum index of matrix a dim b
  106.         matmin    2      minimum index of matrix a dim b
  107.         mattrans  1      transpose of matrix
  108.         max       1+     maximum value
  109.         meq       3      whether a and b are equal modulo c
  110.         min       1+     minimum value
  111.         minv      2      inverse of a modulo b
  112.         mmin      2      a mod b value with smallest abs value
  113.         mne       3      whether a and b are not equal modulo c
  114.         near      2-3    sign of (abs(a-b) - c)
  115.         norm      1      norm of a value (square of absolute value)
  116.         null      0      null value
  117.         num       1      numerator of fraction
  118.         ord       1      integer corresponding to character value
  119.         param     1      value of parameter n (or parameter count if
  120.                      n is zero)
  121.         perm      2      permutation number a!/(a-b)!
  122.         pfact     1      product of primes up till number
  123.         pi        0-1    value of pi accurate to within epsilon
  124.         places    1      places after decimal point (-1 if infinite)
  125.         pmod      3      mod of a power (a ^ b (mod c))
  126.         polar     2-3    complex value of polar coordinate
  127.                      (a * exp(b*1i))
  128.         poly      2+     (a1,a2,...,an,x) = a1*x^n+a2*x^(n-1)+...+an
  129.         pop       1      pop value from front of list
  130.         power     2-3    value a raised to the power b within accuracy c
  131.         ptest     2      probabilistic primality test
  132.         printf    1+     print formatted output to stdout
  133.         prompt    1      prompt for input line using value a
  134.         push      2      push value onto front of list
  135.         quomod    4      set c and d to quotient and remainder of a divided by b
  136.         rcin      2      convert normal number a to REDC number mod b
  137.         rcmul     3      multiply REDC numbers a and b mod c
  138.         rcout     2      convert REDC number a mod b to normal number
  139.         rcpow     3      raise REDC number a to power b mod c
  140.         rcsq      2      square REDC number a mod b
  141.         re        1      real part of complex number
  142.         remove    1      remove value from end of list
  143.         root      2-3    value a taken to the b'th root within accuracy c
  144.         round     1-2    round value a to b number of decimal places
  145.         rsearch   2-3    reverse search matrix or list for value b
  146.                      starting at index c
  147.         runtime   0      user mode cpu time in seconds
  148.         scale     2      scale value up or down by a power of two
  149.         search    2-3    search matrix or list for value b starting at
  150.                      index c
  151.         sgn       1      sign of value (-1, 0, 1)
  152.         sin       1-2    sine of value a within accuracy b
  153.         sinh      1-2    hyperbolic sine of a within accuracy b
  154.         size      1      total number of elements in value
  155.         sqrt      1-2    square root of value a within accuracy b
  156.         ssq       1+     sum of squares of values
  157.         str       1      simple value converted to string
  158.         strcat    1+     concatenate strings together
  159.         strlen    1      length of string
  160.         strprintf 1+     return formatted output as a string
  161.         substr    3      substring of a from position b for c chars
  162.         swap      2      swap values of variables a and b
  163.                      (can be dangerous)
  164.         tan       1-2    tangent of a within accuracy b
  165.         tanh      1-2    hyperbolic tangent of a within accuracy b
  166.         trunc     1-2    truncate a to b number of decimal places
  167.         xor       1+     logical xor
  168.  
  169.  
  170.     The config function sets or reads the value of a configuration
  171.     parameter.  The first argument is a string which names the parameter
  172.     to be set or read.  If only one argument is given, then the current
  173.     value of the named parameter is returned.  If two arguments are given,
  174.     then the named parameter is set to the value of the second argument,
  175.     and the old value of the parameter is returned.  Therefore you can
  176.     change a parameter and restore its old value later.  The possible
  177.     parameters are explained in the next section.
  178.  
  179.     The scale function multiplies or divides a number by a power of 2.
  180.     This is used for fractional calculations, unlike the << and >>
  181.     operators, which are only defined for integers.  For example,
  182.     scale(6, -3) is 3/4.
  183.  
  184.     The quomod function is used to obtain both the quotient and remainder
  185.     of a division in one operation.  The first two arguments a and b are
  186.     the numbers to be divided.  The last two arguments c and d are two
  187.     variables which will be assigned the quotient and remainder.  For
  188.     nonnegative arguments, the results are equivalent to computing a//b
  189.     and a%b.  If a is negative and the remainder is nonzero, then the
  190.     quotient will be one less than a//b.  This makes the following three
  191.     properties always hold:  The quotient c is always an integer.  The
  192.     remainder d is always 0 <= d < b.  The equation a = b * c + d always
  193.     holds.  This function returns 0 if there is no remainder, and 1 if
  194.     there is a remainder.  For examples, quomod(10, 3, x, y) sets x to 3,
  195.     y to 1, and returns the value 1, and quomod(-4, 3.14159, x, y) sets x
  196.     to -2, y to 2.28318, and returns the value 1.
  197.  
  198.     The eval function accepts a string argument and evaluates the
  199.     expression represented by the string and returns its value.
  200.     The expression can include function calls and variable references.
  201.     For example, eval("fact(3) + 7") returns 13.  When combined with
  202.     the prompt function, this allows the calculator to read values from
  203.     the user.  For example, x=eval(prompt("Number: ")) sets x to the
  204.     value input by the user.
  205.  
  206.     The digit and isset functions return individual digits of a number,
  207.     either in base 10 or in base 2, where the lowest digit of a number
  208.     is at digit position 0.  For example, digit(5678, 3) is 5, and
  209.     isset(0b1000100, 2) is 1.  Negative digit positions indicate places
  210.     to the right of the decimal or binary point, so that for example,
  211.     digit(3.456, -1) is 4.
  212.  
  213.     The ptest function is a primality testing function.  The first
  214.     argument is the suspected prime to be tested.  The second argument
  215.     is an iteration count.  The function returns 0 if the number is
  216.     definitely not prime, and 1 is the number is probably prime.  The
  217.     chance of a number which is probably prime being actually composite
  218.     is less than 1/4 raised to the power of the iteration count.  For
  219.     example, for a random number p, ptest(p, 10) incorrectly returns 1
  220.     less than once in every million numbers, and you will probably never
  221.     find a number where ptest(p, 20) gives the wrong answer.
  222.  
  223.     The functions rcin, rcmul, rcout, rcpow, and rcsq are used to
  224.     perform modular arithmetic calculations for large odd numbers
  225.     faster than the usual methods.  To do this, you first use the
  226.     rcin function to convert all input values into numbers which are
  227.     in a format called REDC format.  Then you use rcmul, rcsq, and
  228.     rcpow to multiply such numbers together to produce results also
  229.     in REDC format.  Finally, you use rcout to convert a number in
  230.     REDC format back to a normal number.  The addition, subtraction,
  231.     negation, and equality comparison between REDC numbers are done
  232.     using the normal modular methods.  For example, to calculate the
  233.     value 13 * 17 + 1 (mod 11), you could use:
  234.  
  235.         p = 11;
  236.         t1 = rcin(13, p);
  237.         t2 = rcin(17, p);
  238.         t3 = rcin(1, p);
  239.         t4 = rcmul(t1, t2, p);
  240.         t5 = (t4 + t3) % p;
  241.         answer = rcout(t5, p);
  242.  
  243.     The swap function exchanges the values of two variables without
  244.     performing copies.  For example, after:
  245.  
  246.         x = 17;
  247.         y = 19;
  248.         swap(x, y);
  249.  
  250.     then x is 19 and y is 17.  This function should not be used to
  251.     swap a value which is contained within another one.  If this is
  252.     done, then some memory will be lost.  For example, the following
  253.     should not be done:
  254.  
  255.         mat x[5];
  256.         swap(x, x[0]);
  257.